vcTransportSystem

Transport system is a management and query service for vcTransportNode and vcTransportLink objects that form a transportation graph. It is owned by a vcProcessController.

See in: Overview

Module: vcProcessModel

Parent: vcObject

Children -

Referenced by: vcProcessController.TransportSystem, vcTransportNode.TransportSystem

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

Name	Type	Access	Description
Controllers	vcObservableList[vcTransportController]	R	Gets all transport controllers associated with this system.
Links	vcObservableList[vcTransportLink]	R	Gets all transport links associated with this system.
Nodes	vcObservableList[vcTransportNode]	R	Gets all transport nodes associated with this system.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

Name	Return Type	Parameters	Description
createTransportLink	vcTransportLink	vcTransportNode source, vcTransportNode destination, vcBehavior implementer, vcProcessFlowGroup group	Creates a new transport link from source to destination node and registers it to the system. Source and destination have to be in this transport system and cannot be the same. See more Parameters: source (vcTransportNode): The transport node to start moving from. destination (vcTransportNode): The destination transport node. implementer (vcBehavior): The transport controller or a container as interpolating transport controller that will take care of moving the product through this link. group (vcProcessFlowGroup): Only product types belonging to this flow group can travel through this link. Exceptions: ValueError: When source and destination are the same. ValueError: When source or destination are not part of this transport system. TypeError: When implementer is not a transport controller. Returns: vcTransportLink: The newly created link between source and destination.
findAllLinksBetweenNodeSets	vcList	List[vcTransportNode] sourceNodes, List[vcTransportNode] destinationNodes, vcProcessFlowGroup group	Tries to find a valid route from source to destination, only considers links that support the given flow group. See more The route isn't optimized. Parameters: source (vcTransportNode): The source node to search from. destination (vcTransportNode): The destination node. group (vcProcessFlowGroup): The flow group that all transport links need to support. Returns: vcTransportSolution: The found transport solution, or None if no solution was found.
findSolution	vcTransportSolution	vcTransportNode source, vcTransportNode destination, vcProcessFlowGroup group	Tries to find a valid route from source to destination, only considers links that support the given flow group. See more The route isn't optimized. Parameters: source (vcTransportNode): The source node to search from. destination (vcTransportNode): The destination node. group (vcProcessFlowGroup): The flow group that all transport links need to support. Returns: vcTransportSolution: The found transport solution, or None if no solution was found.

Events

Learn how to use events here. The events are also inherited from the parent class.

Name	Parameters	Description
OnTransportLinkRemoved	vcTransportGroup group, vcTransportNode source, vcTransportNode destination	Called when a transport link was removed from the system. See more Parameters: group (vcTransportGroup): The group the removed link was part of. source (vcTransportNode): The source node of the removed link. destination (vcTransportNode): The destination node of the removed link